<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.commons.io.filefilter;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.nio.file.FileVisitResult;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.nio.file.Path;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.nio.file.attribute.BasicFileAttributes;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.function.Function;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.regex.Pattern;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.commons.io.IOCase;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Filters files using supplied regular expression(s).<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * See java.util.regex.Pattern for regex matching rules.<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;/p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;h2&gt;Using Classic IO&lt;/h2&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * e.g.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;pre&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * File dir = new File(".");<a name="line.39"></a>
<span class="sourceLineNo">040</span> * FileFilter fileFilter = new RegexFileFilter("^.*[tT]est(-\\d+)?\\.java$");<a name="line.40"></a>
<span class="sourceLineNo">041</span> * File[] files = dir.listFiles(fileFilter);<a name="line.41"></a>
<span class="sourceLineNo">042</span> * for (String file : files) {<a name="line.42"></a>
<span class="sourceLineNo">043</span> *     System.out.println(file);<a name="line.43"></a>
<span class="sourceLineNo">044</span> * }<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;/pre&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> *<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;h2&gt;Using NIO&lt;/h2&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;pre&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * final Path dir = Paths.get("");<a name="line.50"></a>
<span class="sourceLineNo">051</span> * final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new RegexFileFilter("^.*[tT]est(-\\d+)?\\.java$"));<a name="line.51"></a>
<span class="sourceLineNo">052</span> * //<a name="line.52"></a>
<span class="sourceLineNo">053</span> * // Walk one dir<a name="line.53"></a>
<span class="sourceLineNo">054</span> * Files.&lt;b&gt;walkFileTree&lt;/b&gt;(dir, Collections.emptySet(), 1, visitor);<a name="line.54"></a>
<span class="sourceLineNo">055</span> * System.out.println(visitor.getPathCounters());<a name="line.55"></a>
<span class="sourceLineNo">056</span> * System.out.println(visitor.getFileList());<a name="line.56"></a>
<span class="sourceLineNo">057</span> * //<a name="line.57"></a>
<span class="sourceLineNo">058</span> * visitor.getPathCounters().reset();<a name="line.58"></a>
<span class="sourceLineNo">059</span> * //<a name="line.59"></a>
<span class="sourceLineNo">060</span> * // Walk dir tree<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Files.&lt;b&gt;walkFileTree&lt;/b&gt;(dir, visitor);<a name="line.61"></a>
<span class="sourceLineNo">062</span> * System.out.println(visitor.getPathCounters());<a name="line.62"></a>
<span class="sourceLineNo">063</span> * System.out.println(visitor.getDirList());<a name="line.63"></a>
<span class="sourceLineNo">064</span> * System.out.println(visitor.getFileList());<a name="line.64"></a>
<span class="sourceLineNo">065</span> * &lt;/pre&gt;<a name="line.65"></a>
<span class="sourceLineNo">066</span> *<a name="line.66"></a>
<span class="sourceLineNo">067</span> * @since 1.4<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span>public class RegexFileFilter extends AbstractFileFilter implements Serializable {<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>    private static final long serialVersionUID = 4269646126155225062L;<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Compiles the given pattern source.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @param pattern the source pattern.<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @param flags the compilation flags.<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * @return a new Pattern.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     */<a name="line.79"></a>
<span class="sourceLineNo">080</span>    private static Pattern compile(final String pattern, final int flags) {<a name="line.80"></a>
<span class="sourceLineNo">081</span>        if (pattern == null) {<a name="line.81"></a>
<span class="sourceLineNo">082</span>            throw new IllegalArgumentException("Pattern is missing");<a name="line.82"></a>
<span class="sourceLineNo">083</span>        }<a name="line.83"></a>
<span class="sourceLineNo">084</span>        return Pattern.compile(pattern, flags);<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /**<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * Converts IOCase to Pattern compilation flags.<a name="line.88"></a>
<span class="sourceLineNo">089</span>     *<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * @param caseSensitivity case-sensitivity.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @return Pattern compilation flags.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    private static int toFlags(final IOCase caseSensitivity) {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        return IOCase.isCaseSensitive(caseSensitivity) ? Pattern.CASE_INSENSITIVE : 0;<a name="line.94"></a>
<span class="sourceLineNo">095</span>    }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    /** The regular expression pattern that will be used to match file names. */<a name="line.97"></a>
<span class="sourceLineNo">098</span>    private final Pattern pattern;<a name="line.98"></a>
<span class="sourceLineNo">099</span>    <a name="line.99"></a>
<span class="sourceLineNo">100</span>    /** How convert a path to a string. */<a name="line.100"></a>
<span class="sourceLineNo">101</span>    private final Function&lt;Path, String&gt; pathToString;<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>    /**<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * Constructs a new regular expression filter for a compiled regular expression<a name="line.104"></a>
<span class="sourceLineNo">105</span>     *<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * @param pattern regular expression to match.<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * @throws IllegalArgumentException if the pattern is null.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     */<a name="line.108"></a>
<span class="sourceLineNo">109</span>    public RegexFileFilter(final Pattern pattern) {<a name="line.109"></a>
<span class="sourceLineNo">110</span>        this(pattern, p -&gt; p.getFileName().toString());<a name="line.110"></a>
<span class="sourceLineNo">111</span>    }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span>    /**<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * Constructs a new regular expression filter for a compiled regular expression<a name="line.114"></a>
<span class="sourceLineNo">115</span>     *<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * @param pattern regular expression to match.<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * @param pathToString How convert a path to a string.<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * @throws IllegalArgumentException if the pattern is null.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * @since 2.10.0<a name="line.119"></a>
<span class="sourceLineNo">120</span>     */<a name="line.120"></a>
<span class="sourceLineNo">121</span>    public RegexFileFilter(final Pattern pattern, final Function&lt;Path, String&gt; pathToString) {<a name="line.121"></a>
<span class="sourceLineNo">122</span>        if (pattern == null) {<a name="line.122"></a>
<span class="sourceLineNo">123</span>            throw new IllegalArgumentException("Pattern is missing");<a name="line.123"></a>
<span class="sourceLineNo">124</span>        }<a name="line.124"></a>
<span class="sourceLineNo">125</span>        this.pattern = pattern;<a name="line.125"></a>
<span class="sourceLineNo">126</span>        this.pathToString = pathToString;<a name="line.126"></a>
<span class="sourceLineNo">127</span>    }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    /**<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * Constructs a new regular expression filter.<a name="line.130"></a>
<span class="sourceLineNo">131</span>     *<a name="line.131"></a>
<span class="sourceLineNo">132</span>     * @param pattern regular string expression to match<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * @throws IllegalArgumentException if the pattern is null<a name="line.133"></a>
<span class="sourceLineNo">134</span>     */<a name="line.134"></a>
<span class="sourceLineNo">135</span>    public RegexFileFilter(final String pattern) {<a name="line.135"></a>
<span class="sourceLineNo">136</span>        this(pattern, 0);<a name="line.136"></a>
<span class="sourceLineNo">137</span>    }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span>    /**<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * Constructs a new regular expression filter with the specified flags.<a name="line.140"></a>
<span class="sourceLineNo">141</span>     *<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * @param pattern regular string expression to match<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * @param flags pattern flags - e.g. {@link Pattern#CASE_INSENSITIVE}<a name="line.143"></a>
<span class="sourceLineNo">144</span>     * @throws IllegalArgumentException if the pattern is null<a name="line.144"></a>
<span class="sourceLineNo">145</span>     */<a name="line.145"></a>
<span class="sourceLineNo">146</span>    public RegexFileFilter(final String pattern, final int flags) {<a name="line.146"></a>
<span class="sourceLineNo">147</span>        this(compile(pattern, flags));<a name="line.147"></a>
<span class="sourceLineNo">148</span>    }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span>    /**<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * Constructs a new regular expression filter with the specified flags case sensitivity.<a name="line.151"></a>
<span class="sourceLineNo">152</span>     *<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * @param pattern regular string expression to match<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @param caseSensitivity how to handle case sensitivity, null means case-sensitive<a name="line.154"></a>
<span class="sourceLineNo">155</span>     * @throws IllegalArgumentException if the pattern is null<a name="line.155"></a>
<span class="sourceLineNo">156</span>     */<a name="line.156"></a>
<span class="sourceLineNo">157</span>    public RegexFileFilter(final String pattern, final IOCase caseSensitivity) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>        this(compile(pattern, toFlags(caseSensitivity)));<a name="line.158"></a>
<span class="sourceLineNo">159</span>    }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>    /**<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * Checks to see if the file name matches one of the regular expressions.<a name="line.162"></a>
<span class="sourceLineNo">163</span>     *<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * @param dir the file directory (ignored)<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * @param name the file name<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * @return true if the file name matches one of the regular expressions<a name="line.166"></a>
<span class="sourceLineNo">167</span>     */<a name="line.167"></a>
<span class="sourceLineNo">168</span>    @Override<a name="line.168"></a>
<span class="sourceLineNo">169</span>    public boolean accept(final File dir, final String name) {<a name="line.169"></a>
<span class="sourceLineNo">170</span>        return pattern.matcher(name).matches();<a name="line.170"></a>
<span class="sourceLineNo">171</span>    }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span>    /**<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * Checks to see if the file name matches one of the regular expressions.<a name="line.174"></a>
<span class="sourceLineNo">175</span>     *<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * @param path the path<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * @param attributes the path attributes<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * @return true if the file name matches one of the regular expressions<a name="line.178"></a>
<span class="sourceLineNo">179</span>     */<a name="line.179"></a>
<span class="sourceLineNo">180</span>    @Override<a name="line.180"></a>
<span class="sourceLineNo">181</span>    public FileVisitResult accept(final Path path, final BasicFileAttributes attributes) {<a name="line.181"></a>
<span class="sourceLineNo">182</span>        return toFileVisitResult(pattern.matcher(pathToString.apply(path)).matches(), path);<a name="line.182"></a>
<span class="sourceLineNo">183</span>    }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>    /**<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * Returns a debug string.<a name="line.186"></a>
<span class="sourceLineNo">187</span>     *<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * @since 2.10.0<a name="line.188"></a>
<span class="sourceLineNo">189</span>     */<a name="line.189"></a>
<span class="sourceLineNo">190</span>    @Override<a name="line.190"></a>
<span class="sourceLineNo">191</span>    public String toString() {<a name="line.191"></a>
<span class="sourceLineNo">192</span>        return "RegexFileFilter [pattern=" + pattern + "]";<a name="line.192"></a>
<span class="sourceLineNo">193</span>    }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span>}<a name="line.195"></a>




























































</pre>
</div>
</body>
</html>
